docs: Add CLI direct shortcuts and machine-mode flag#1753
Open
claudespice wants to merge 1 commit into
Open
Conversation
Documents top-level shortcuts (-sql, -p / -chat) and the global --machine / --programmatic flag introduced in spiceai/spiceai#10815. Source: spiceai/spiceai#10815
✅ Pull with Spice PassedPassing checks:
|
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://e3ba5828.spiceai-org-website.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents three user-visible CLI additions introduced in spiceai/spiceai#10815:
spice -sql <query>andspice -p <prompt>/spice -chat <prompt>for one-shot SQL and chat invocations without typing the subcommand.--machine(alias--programmatic) flag for JSON-output / structured-error mode, intended for LLM agents and CI automation.Source PRs
Changes
website/docs/cli/index.md--machine/--programmaticsemantics, position-agnostic behavior, and JSON defaulting for supported subcommands.Test plan
cd website && npm run buildpasses locally (Docusaurus throws on broken links and undefined frontmatter tags)bin/spice/src/main.rs::normalize_direct_shortcut_args(-sql→sql --query,-p/-chat→chat --direct-prompt)--machine/--programmaticglobal flag definition atbin/spice/src/main.rs:122-123and machine-mode dispatch inapply_machine_mode